RS setup scripts updates #1496

basiliskus · 2024-10-25T22:23:48Z

RS setup scripts updates

Consolidated RS setup scripts into one to simplify process
Updated RS Setup instructions
Improved handling of shared variables by adding .env file template
Consolidated readme files into one to have one place where scripts are documented
Refactored scripts in /scripts for separation of concerns, code reusability, maintenance and discoverability
Updated to reference files with absolute paths so scripts can be moved and run anywhere

Issue

#1488

…v variable for RS_HOME

github-actions · 2024-10-25T22:24:42Z

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅ 1488 - Fully compliant Fully compliant requirements: Add script to automate updating RS org settings for local testing
⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review Hardcoded Paths The script contains hardcoded paths for keys and settings, which might not be flexible for different environments or users.

github-actions · 2024-10-25T22:25:41Z

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Possible bug	Check and ensure environment variables are set before use to prevent runtime errors Ensure that the `CDCTI_HOME` environment variable is set before using it to construct the `flexion_key` path to avoid potential runtime errors. scripts/rs/load-etor-org-settings.sh [16] +if [ -z "$CDCTI_HOME" ]; then + echo "CDCTI_HOME is not set. Please set it before running this script." + exit 1 +fi flexion_key="$CDCTI_HOME/mock_credentials/organization-trusted-intermediary-public-key-local.pem" Suggestion importance[1-10]: 9 Why: This suggestion is highly relevant as it prevents the script from failing due to an unset `CDCTI_HOME` environment variable, which is crucial for constructing paths in the script.	9
	Ensure critical environment variables are set before use to prevent script failure Add error handling to check if the `RS_HOME` environment variable is set before changing the directory, to prevent the script from failing silently if the variable is not set. scripts/rs/reset.sh [9] +if [ -z "$RS_HOME" ]; then + echo "RS_HOME is not set. Please set it before running this script." + exit 1 +fi cd "$RS_HOME" Suggestion importance[1-10]: 9 Why: This suggestion is crucial as it adds necessary error handling for an unset `RS_HOME` environment variable before attempting to change directories, which is essential for the script's successful execution.	9
	Verify the availability of necessary commands before execution to avoid runtime failures Consider adding a check to ensure that the `prime` command is available and executable before attempting to run it to set multiple settings and add keys. scripts/rs/load-etor-org-settings.sh [10-20] +if ! command -v ./prime &> /dev/null +then + echo "prime command could not be found" + exit +fi ./prime multiple-settings set -s -i ./settings/STLTs/Flexion/flexion.yml ... ./prime organization addkey --public-key $flexion_key --scope "flexion.*.report" --orgName flexion --kid flexion.simulated-sender --doit Suggestion importance[1-10]: 8 Why: This suggestion is very important as it ensures the `prime` command is available and executable before running it, which is critical for the script's operations and prevents runtime errors.	8
Maintainability	Remove duplicate lines to improve script clarity and maintainability Remove the duplicate export of `CDCTI_HOME` to clean up the script and avoid confusion. scripts/start-here.sh [3-5] -export CDCTI_HOME="/path/to/trusted-intermediary" export CDCTI_HOME="/path/to/trusted-intermediary" Suggestion importance[1-10]: 7 Why: Removing the duplicate export of `CDCTI_HOME` improves the script's clarity and maintainability, making it easier to read and manage.	7

…ng absolute path

…me of the envars. Also working of having absolute paths so the scripts could run from anywhere

…ov/trusted-intermediary into story/1488/rs-setup-scripts-updates

- Use new setup-rs.sh script - Add alternate ways to build and run RS - Fixed RS docs URL - Clean up and simplify

basiliskus · 2024-10-30T16:43:15Z

/review

github-actions · 2024-10-30T16:44:23Z

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅ 1488 - Fully compliant Fully compliant requirements: Add script to automate updating RS org settings for local testing Refactor scripts in `/scripts` for separation of concerns, code reusability, maintenance and discoverability
⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review Script Path Hardcoding The script paths are hardcoded which might cause issues if the environment or directory structure changes. Consider using environment variables or relative paths. Hardcoded URLs The script contains hardcoded URLs which could lead to maintenance issues or errors if the URLs change or need to be different per environment.

scripts/lib/submission-utils.sh

scripts/setup/setup-reportstream.sh

scripts/ti.sh

pluckyswan · 2024-10-30T17:28:02Z

scripts/setup/setup-reportstream.sh

+CURRENT_DIR=$(pwd)
+cd "$RS_HOME" || exit
+
+# source "./prime-router/.vault/env/.env.local"


Not sure what this comment means

Missed that. We don't need it so will remove it

pluckyswan · 2024-10-30T17:30:11Z

scripts/README.md

+
+#### Requirements
+
+- hurl


Might be helpful to add links to installation pages for the requirements

I added the links to the Resources section at the bottom so we don't have multiple repeated URLs

…edentials

sonarqubecloud · 2024-10-31T23:35:45Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

basiliskus added 2 commits October 25, 2024 15:22

Simplified load-etor-org-settings script to only run in local env

75d1252

Using preferred gradlew commands instead of prime ones. Also added en…

917ba54

…v variable for RS_HOME

basiliskus added 24 commits October 28, 2024 08:12

Merge branch 'main' into story/1488/rs-setup-scripts-updates

4fb5278

Merge branch 'main' into story/1488/rs-setup-scripts-updates

8a4eb30

Moved common functions to /scripts/utils.sh and importing scripts usi…

12609d1

…ng absolute path

Merge branch 'main' into story/1488/rs-setup-scripts-updates

941e0d2

Extract env variables to a shared .env file, updated docs, renamed so…

d3b9213

…me of the envars. Also working of having absolute paths so the scripts could run from anywhere

Fixed .env loading and some cleanup

943dfda

Renamed reset.sh => setup.sh

9ff58cb

Merge branch 'main' into story/1488/rs-setup-scripts-updates

a670509

Merge branch 'story/1488/rs-setup-scripts-updates' of github.com:CDCg…

ebf13b2

…ov/trusted-intermediary into story/1488/rs-setup-scripts-updates

Consolidated RS setup scripts into one

4261609

Moved rs/setup.sh to setup-rs.sh and removed rs/ folder

4197def

Updated RS setup instructions in readme to:

9af0985

- Use new setup-rs.sh script - Add alternate ways to build and run RS - Fixed RS docs URL - Clean up and simplify

Moved files to reorganize and simplify file structure

9e059aa

Updated paths

abb1c74

Reverted moving hurl files

08d7789

Moved and renamed function scripts

dc77d21

Moved and renamed more scripts + added to readme

5e700e7

Moved function to common.sh

5ecda59

Removed unused hurl/readme.md

2bdb725

Fixed .env file reference

bb8b027

Added to readme and added user message to find instructions

caf441c

Added context to instruction

1f4cf89

Added setup script for env vars

7a7909e

Changed relative path to hurl files for absolute paths

c1043df

basiliskus marked this pull request as ready for review October 30, 2024 15:28

Fixed typos and cleanup

5935548

github-actions bot reviewed Oct 30, 2024

View reviewed changes

scripts/lib/submission-utils.sh Show resolved Hide resolved

scripts/setup/setup-reportstream.sh Show resolved Hide resolved

scripts/ti.sh Show resolved Hide resolved

basiliskus added 2 commits October 30, 2024 10:03

Removed setup script not working as intended

d70bb49

Readme update

da784d7

pluckyswan reviewed Oct 30, 2024

View reviewed changes

basiliskus added 3 commits October 30, 2024 10:37

Fixed issues after running shellcheck

66c1ed8

Removed dead code and renamed readme section

32c027f

Reverted adding double quotes as it introduces a bug

802b635

basiliskus requested a review from pluckyswan October 31, 2024 18:07

basiliskus added 2 commits October 31, 2024 12:14

Added missing export of env vars that are required to create vault cr…

52e14ba

…edentials

Fixed typo

eec024b

saquino0827 approved these changes Nov 1, 2024

View reviewed changes

basiliskus merged commit fbad979 into main Nov 1, 2024
17 checks passed

basiliskus deleted the story/1488/rs-setup-scripts-updates branch November 1, 2024 20:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RS setup scripts updates #1496

RS setup scripts updates #1496

basiliskus commented Oct 25, 2024 •

edited

Loading

github-actions bot commented Oct 25, 2024

github-actions bot commented Oct 25, 2024

basiliskus commented Oct 30, 2024

github-actions bot commented Oct 30, 2024

pluckyswan Oct 30, 2024

basiliskus Oct 30, 2024

pluckyswan Oct 30, 2024

basiliskus Oct 30, 2024

sonarqubecloud bot commented Oct 31, 2024

RS setup scripts updates #1496

RS setup scripts updates #1496

Conversation

basiliskus commented Oct 25, 2024 • edited Loading

RS setup scripts updates

Issue

github-actions bot commented Oct 25, 2024

PR Reviewer Guide 🔍

github-actions bot commented Oct 25, 2024

PR Code Suggestions ✨

basiliskus commented Oct 30, 2024

github-actions bot commented Oct 30, 2024

PR Reviewer Guide 🔍

pluckyswan Oct 30, 2024

Choose a reason for hiding this comment

basiliskus Oct 30, 2024

Choose a reason for hiding this comment

pluckyswan Oct 30, 2024

Choose a reason for hiding this comment

basiliskus Oct 30, 2024

Choose a reason for hiding this comment

sonarqubecloud bot commented Oct 31, 2024

Quality Gate passed

basiliskus commented Oct 25, 2024 •

edited

Loading